<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">


<!-- remove old header -->


<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>cogen API Reference Documentation
        - Module: sockets</title><meta name="MSSmartTagsPreventParsing" content="true" /><meta http-equiv="imagetoolbar" content="no" /><link href="css/default.css" rel="stylesheet" type="text/css" /><link href="css/pygments.css" rel="stylesheet" type="text/css" />
    <!-- <link rel="shortcut icon" href="/images/favicon.ico" type="image/vnd.microsoft.icon"/> -->
    <link rel="stylesheet" href="css/apydia.css" type="text/css" />
    <script src="js/jquery-1.2.1.pack.js" type="text/javascript"></script>
    <script src="js/apydia.js" type="text/javascript"></script>
	<link rel="icon" href="images/favicon.ico" type="image/x-icon" />
</head>
<body>
    <div id="page">
        <div id="browser">
            <div class="browser-section">
                <h2>Module Index</h2>
                <ul>
                    <li>
                        <a href="cogen.html">cogen</a>
                    </li><li>
                        <a href="cogen.common.html">cogen.common</a>
                    </li><li>
                        <a href="cogen.core.html">cogen.core</a>
                    </li><li>
                        <a href="cogen.web.html">cogen.web</a>
                    </li>
                </ul>
            </div>
            <div class="browser-section">
                <h2>Classes</h2>
                <ul>
                    <li>
                        <a href="cogen.core.sockets.Accept.html">Accept</a>
                    </li><li>
                        <a href="cogen.core.sockets.Connect.html">Connect</a>
                    </li><li>
                        <a href="cogen.core.sockets.Operation.html">Operation</a>
                    </li><li>
                        <a href="cogen.core.sockets.Read.html">Read</a>
                    </li><li>
                        <a href="cogen.core.sockets.ReadAll.html">ReadAll</a>
                    </li><li>
                        <a href="cogen.core.sockets.ReadLine.html">ReadLine</a>
                    </li><li>
                        <a href="cogen.core.sockets.SendFile.html">SendFile</a>
                    </li><li>
                        <a href="cogen.core.sockets.Socket.html">Socket</a>
                    </li><li>
                        <a href="cogen.core.sockets.Write.html">Write</a>
                    </li><li>
                        <a href="cogen.core.sockets.WriteAll.html">WriteAll</a>
                    </li>
                </ul>
            </div>
        </div>
        <div id="content">
    <h1>Module: sockets</h1>
    <div class="docstring rst"></div>
    <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L1">View source</a>
    </li>
</ul>
    <div>
        <h2>Classes</h2>
            <h3>
                <a href="cogen.core.sockets.Accept.html">Accept</a>
            </h3>
            <div class="docstring rst"><p>Returns a (conn, addr) tuple when the operation completes.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Accept.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L321">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.Connect.html">Connect</a>
            </h3>
            <div class="docstring rst"><p>Connect to the given <cite>addr</cite> using <cite>sock</cite>.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Connect.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L341">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.Operation.html">Operation</a>
            </h3>
            <div class="docstring rst"></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Operation.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L47">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.Read.html">Read</a>
            </h3>
            <div class="docstring rst"><p><cite>len</cite> is max read size, BUT, if if there are buffers from ReadLine return them first.
Example usage:</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Read.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L159">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.ReadAll.html">ReadAll</a>
            </h3>
            <div class="docstring rst"><p>Run this operator till we've read <cite>len</cite> bytes.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.ReadAll.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L192">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.ReadLine.html">ReadLine</a>
            </h3>
            <div class="docstring rst"><p>Run this operator till we read a newline (n) or we have a overflow.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.ReadLine.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L226">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.SendFile.html">SendFile</a>
            </h3>
            <div class="docstring rst"><p>Uses underling OS sendfile call or a regular memory copy operation if there is no sendfile.
You can use this as a WriteAll if you specify the length.
Usage:</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.SendFile.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L104">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.Socket.html">Socket</a>
            </h3>
            <div class="docstring rst"></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Socket.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L25">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.Write.html">Write</a>
            </h3>
            <div class="docstring rst"><p>Write the buffer to the socket and return the number of bytes written.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.Write.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L286">View source</a>
    </li>
</ul>
            <h3>
                <a href="cogen.core.sockets.WriteAll.html">WriteAll</a>
            </h3>
            <div class="docstring rst"><p>Run this operation till all the bytes have been written.</p></div>
            <ul class="link-bar">
    <li class="top"><a href="#header">Top</a></li>
    <li>
        <a href="cogen.core.sockets.WriteAll.html">Details</a>
    </li>
    <li class="link-to-sourcecode">
        <a href="http://cogen.googlecode.com/svn/trunk/cogen/core/sockets.py#L302">View source</a>
    </li>
</ul>
    </div>
        </div>
        <div id="footer">
            Generated with <a href="http://apydia.ematia.de/" class="extern">
            Apydia 0.0.1</a> on 2007-12-25 18:33
        </div>
    </div>
</body>
</html>